Update JSON schema migration to require id, created, and updated on responses
#16391
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
desertaxle
force-pushed
the
fix-optional-ids-open-api
branch
from
3aa1432 to
73925d8
Compare
CodSpeed Performance ReportMerging #16391 will not alter performanceComparing Summary
|
desertaxle
requested review from
aaazzam,
cicdw,
zzstoatzz and
discdiver
as code owners
devinvillarosa
pushed a commit
that referenced
this pull request
Dec 24, 2024
…` on responses (#16391)
devinvillarosa
pushed a commit
that referenced
this pull request
Dec 24, 2024
…` on responses (#16391)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The generated client for the v2 UI has been showing
id,created, andupdatedas optional for a response from the API, even though they should always be present. I tracked this down to the response models inheriting from ORMBaseModel, which has default factories for these three fields. The default factories will cause these fields to appear optional in the generated OpenAPI schema.This PR customizes the JSON schema generation for
ORMBaseModelandIDBaseModelto ensure thatid,created, andupdatedappear as required in the generated JSON schema. This is reflected in the changes to the generated UI client code. Any other UI changes are to account for type errors from the new typing.